Skip to main content

HumanResourcesAPI Methods

An object defining methods for the HumanResourcesAPI class.

SetUrl(url)​

Sets the API URL for requests.

Parameters:​

url (required): string
The new API URL.

Returns:​

Type: void
Method does not return anything

Exceptions:​

Type: ArgumentNullException
Throws ArgumentNullException if URL is null or empty.

Type: Exception
Throws Exception if the URL is invalid.

This is a sync method. Method runs synchronously.

GetUserByUserId(userId, telemetryCollectorHolder)​

Gets the information of the user whose user id is given.

Parameters:​

userId (required): long
The ID number of the user.

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Optional telemetry collector for gathering execution metrics.

Returns:​

Type: Task<WrapResponse<User>>
A Task that represents the asynchronous operation, with a result of Bimser.Framework.Web.Models.WrapResponse_TResult<Bimser.Synergy.Entities.HumanResources.Business.Objects.User>, containing user details whose user id is given.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also​

GetCurrentUserInfo(telemetryCollectorHolder)​

Gets the logged in user's information.

Parameters:​

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Optional telemetry collector for gathering execution metrics.

Returns:​

Type: Task<WrapResponse<UserObjectStartupInfoResponse>>
A Task that represents the asynchronous operation, with a result of Bimser.Framework.Web.Models.WrapResponse_TResult<Bimser.Synergy.Entities.HumanResources.Business.DTOs.Responses.UserObjectStartupInfoResponse>, containing user startup details for the project.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also​

GetUserByUserName(userName, telemetryCollectorHolder)​

Gets the information of the user whose username is given.

Parameters:​

userName (required): string
The unique username of the user.

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Optional telemetry collector for gathering execution metrics.

Returns:​

Type: Task<WrapResponse<User>>
A Task that represents the asynchronous operation, with a result of Bimser.Framework.Web.Models.WrapResponse_TResult<Bimser.Synergy.Entities.HumanResources.Business.Objects.User>, containing user details whose user id is given.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also​